Health and Social Care Integration
Domain Message Specification

DischargeNoticeMPM Tabular View

COMT_RM000008UK03
DischargeNoticeMPM

A Discharge Notice under the Care Act 2014 Schedule 3. The Discharge Notice is split into Multiple Payloads (hence the root class is a Discharge Notice Multi-Payload Message (MPM)). The payload of a Discharge Notice contains Discharge Notice data and a renderable CDA document version of the Discharge Notice only.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a control act.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "CACT".

[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a control act event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".

[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="975731000000100" }

Model Attribute Description

The HL7 attribute code uses a code from the SnomedCT vocabulary to describe that this is a Discharge Notice under the Care Act 2014 Schedule 3.

Implementation in XML Instance

The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code is fixed to "975731000000100".
  • The XML attribute codeSystem is fixed to "2.16.840.1.113883.2.1.3.2.4.15".
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to define the time the Discharge Notice Multi-payload Message was issued.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time the Discharge Notice Multi-payload Message was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minute
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..2] [M] id (SET)
Model Attribute Description

The HL7 attribute id uses an identifier to identify the acts involved in the Delayed Discharge process, where the:

  • First mandatory id, identifies the Discharge Notice Multi-payload Message instance.
  • The second optional id, identifies the Delayed Discharge process in which this Discharge Notice Multi-payload Message forms part of.

Implementation in XML Instance

The first, mandatory id shall be the identifier of this Discharge Notice Multi-payload Message instance used for transmission. The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.

The second, optional id shall be the identifier of the Delayed Discharge process in which this Discharge Notice Multi-payload Message forms part of. The identifier is the same for all communications sent within the process. This allows cancellation of all communications involved using a single reference. The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] author

The author of the Discharge Notice Multi-payload Message.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an author participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). Therefore, this specifies how the author recipient contributes to the context of the Discharge Notice Multi-payload Message and whether it may be propagated to descendent acts whose association allows such propagation. This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding)- the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100028#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (AuthorChoice)

A link to the available author template choice.

[1..1] [M] callBackContact

The contact details given by the responsible party as a contact point for the Delayed Discharge process.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="CALLBCK" }

Model Attribute Description

The HL7 attribute typeCode uses a code from the HL7 vocabulary ParticipationType to identify that this participation is for a person or organisation who should be specifically contacted for follow-up questions about the information carried in the Discharge Notice message.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "CALLBCK".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100020#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (ReplyToChoice)

A link to the available contact details templates.

[0..1] location

A class which holds details of the location.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="LOC" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this participation as a location.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "LOC".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100023#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.


Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] participant (LocationChoice)

A link to the choice of health care facility location.

[0..1] notificationContact
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="NOT" }
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
[1..1] [M] contentId (II) { "NPFIT-100027#Role" }
[1..1] participant (CarerChoice)
[1..1] [M] primaryInformationRecipient

The primary information recipients for the Discharge Notice Multi-payload Message.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="PRCP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a primary information recipient participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "PRCP".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). Therefore, this specifies how the primary information recipient contributes to the context of the Discharge Notice Multi-payload Message and whether it may be propagated to descendent acts whose association allows such propagation. This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the participation replaces any that has been conducted from any previous acts.
  • "P" (Propagating) - the participation is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100022#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifier.
[1..1] [M] participant (RecipientChoice)

A link to the available primary information recipient choice.

[1..1] [M] recordTarget

A class which is a participation of the record target.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="RCT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a record target participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "RCT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding)- the record target replaces any record target that has been conducted from any previous acts.
  • "P" (Propagating)- the record target is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100021#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (Patient)

A link to the patient template.

[0..1] replacementOf

A reference to the previous Discharge Notice message that this Discharge Notice message replaces.

For the first Discharge Notice message in a Delayed Discharge process, there will be no Discharge Notice message to replace, so this class will not be sent. In subsequent iterations of Discharge Notice within a Delayed Discharge process, this class shall contain the id of the replaced Discharge Notice message.

Note: replacement of a Discharge Notice message includes the replacement of all attached payloads.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="RPLC" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe the type of relationship as one of replacement.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "RPLC".
[1..1] priorReplacedControlActEvent (ReplacedControlActEvent)

A link to the replaced Control Act of the Discharge Notice message.

[1..1] [M] responsibleParty

The party responsible for the Discharge Notice. The responsible party will always be either the NHS trust caring for the patient or the team managing the discharge process for the patient.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="RESP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a responsible party participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "RESP".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). It specifies how the responsible party contributes to the context of the Discharge Notice Multi-payload Message and whether it may be propagated to descendent acts whose association allows such propagation. This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating) - the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100024#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (ResponsiblePartyChoice)

A link to the available responsible party choice.

[1..*] [M] subject

A link to the CDA document attached to the Discharge Notice Multi-payload Message. There shall be a Discharge Notice CDA Document.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="SUBJ" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this as a subject.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "SUBJ".
[1..1] [M] contextConductionInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "false".
[1..1] [M] contentId (II) { "NPFIT-100005#Act" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] seperatableInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "true".
[1..1] [M] cDAChoice (CDAChoice)

A link to the available CDA documents.

[1..1] [M] subject1

A link to the data section of the Discharge Notice message. The data section refers to a machine processable version of the Discharge Notice message.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="SUBJ" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this as a subject.

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "SUBJ".
[1..1] [M] contextConductionInd (BL)
{ Fixed="true" }

Model Attribute Description

The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section).

Implementation in XML Instance

  • The XML attribute contextConductionInd is fixed to "true".
[1..1] [M] contentId (II) { "NPFIT-100004#Act" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] [M] dataTemplateChoice (DataChoice)

The template for machine processable data associated with a Discharge Notice.

AuthorChoice
An abstract placeholder for the templates of an Author.
Used by: DischargeNoticeMPM
[1..1] : Template3
Patient

An abstract placeholder for the templates of a Patient.

Used by: DischargeNoticeMPM
[1..1] : Template4
RecipientChoice

An abstract placeholder for the templates of a Recipient.

Used by: DischargeNoticeMPM
[1..1] : Template5
ResponsiblePartyChoice

An abstract placeholder for the templates of the Responsible Party.

Used by: DischargeNoticeMPM
[1..1] : Template6
CDAChoice
An abstract placeholder for the attached CDA documents.
Used by: DischargeNoticeMPM
[1..1] : Template1
DataChoice
An abstract placeholder for the data associated with the Discharge Notice.
Used by: DischargeNoticeMPM
[1..1] : Template2
ReplyToChoice

An abstract place holder for the templates of the Reply To details.

Used by: DischargeNoticeMPM
[1..1] : Template8
ReplacedControlActEvent

Contains a reference to a previous Control Act, and all it's included CDA documents and data sections, that this Control Act replaces.

Note: All the included CDA documents and data sections in the previous Discharge Notice message are replaced by those in this Discharge Notice message.

Used by: DischargeNoticeMPM
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a control act.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "CACT".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a control act event

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an identifier to identify each unique instance of a control act. This is the unique identifier of the control act that this message replaces.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
CarerChoice
Used by: DischargeNoticeMPM
[1..1] : Template9
LocationChoice

An abstract placeholder for the templates of a Location.

Used by: DischargeNoticeMPM
[1..1] : Template7